home *** CD-ROM | disk | FTP | other *** search
/ Games of Daze / Infomagic - Games of Daze (Summer 1995) (Disc 1 of 2).iso / x2ftp / msdos / utils / hdk115b / hlpdk.hdf < prev    next >
Text File  |  1994-04-12  |  90KB  |  2,574 lines
  1. ;******************************************************************************
  2. ;                                 .linkColor                                  *
  3. ; set link color to lightGreen on blue (lightGreen (10) + 16 * blue (1) )     *
  4. ; and link high color to lightGreen on light gray (10 + 16 * 7)               *
  5. ;******************************************************************************
  6. .linkColor 26
  7. .linkhigh 122
  8.  
  9. ;******************************************************************************
  10. ;                               .titleDefaults                                *
  11. ; default title attributes                                                    *
  12. ;******************************************************************************
  13. .titleDefaults scroll off bgColor 7
  14.  
  15. ;******************************************************************************
  16. ;                                 .fixedFont                                  *
  17. ; use a fixed font for Windows target ..                                      *
  18. ;******************************************************************************
  19. .fixedFont
  20.  
  21. ;******************************************************************************
  22. ;                                  .graphic                                   *
  23. ; this is a demo of a graphic used in this file!                              *
  24. ;******************************************************************************
  25. .graphic ronPicture ronp.bmp
  26. .graphic overviewP  overview.bmp
  27.  
  28. .userlink embeddSound 'sndPlaySound("%t",3)'
  29. .routine sndPlaySound MMSYSTEM Su
  30.  
  31. ;******************************************************************************
  32. ;                                  overview                                   *
  33. ; notice - a .top = .topic = .entry                                           *
  34. ;******************************************************************************
  35. .top overview
  36. .title HLPDK System Overview
  37. .ifdef test
  38. .title ~HLPDK System Overview~overviewP~
  39. .endif
  40. .titleAttr box none
  41. .keywords contents
  42. .list general
  43. .ifdef rtfbased
  44. .ifndef document
  45. .action ~thanks.wav~embeddSound~
  46. .endif
  47. .endif
  48.  
  49. .ifdef rtfbased
  50. .par bold on box shadow size 16 font 6 align center
  51. HyperAct Inc., POB. 5517, Coralville IA 52241, U.S.A
  52. .endpar
  53. .else
  54. .ifdef os2
  55. .insert code
  56. :cgraphic.
  57. .endif
  58.  ╔══════════════════════════════════════════════════════════════════════════╗
  59.  ║                                                                          ║
  60.  ║                               HyperAct Inc.                              ║
  61.  ║                               P.O.Box. 5517                              ║
  62.  ║                         Coralville IA 52241 U.S.A                        ║
  63.  ║                          Compuserve - 76350,333                          ║
  64.  ║                        Phone/Fax - (319) 351-8413                        ║
  65.  ║                                                                          ║
  66.  ╚══════════════════════════════════════════════════════════════════════════╝ 
  67. .ifdef os2
  68. :ecgraphic.
  69. .end-code
  70. .endif
  71. .endif
  72.  
  73. ~Table Of Contents~toc~
  74.  
  75. .par
  76. The Help Engine Development Kit is a system that allows you to create 
  77. hyper-text database help systems with topics and hot links, using a simple
  78. text editor and the help compiler. 
  79. .endpar
  80.  
  81. .par
  82. The help databases can be distributed (free of charge) with the HELPENG or
  83. HE help engine display programs. 
  84. .endpar
  85.  
  86. .par
  87. The help database format is release to the public domain, if you own the 
  88. Paradox Engine you can use the help databases with your own programs. 
  89. .endpar
  90.  
  91. .par
  92. Borland Pascal Users can purchase the Help Engine Source Code even
  93. for Applications that do not use the paradox engine, using the Native Mem
  94. format.
  95. .endpar
  96.  
  97. .par font 13 bold on
  98. The helpC compiler that is part of this development kit includes the
  99. ability to create Windows Help source files from the same source the 
  100. dos help sources are created!. Write your help once, and create help
  101. databases for Dos, Windows, OS/2 and DESQview/X !
  102. .endpar
  103.  
  104. .par box thick italic on color 4
  105. Supported Formats :
  106. Native(PX), Native (Mem), Win30, Win31, QuickHelp, Microsoft Multimedia Viewer,
  107. THELP, TVHC, POPHELP, DESQview/X, OS/2, Text, Word Processors (RTF)
  108. Sony MM Player (Via MM Viewer), WWW HTML (Supporting Windows, 
  109. Macintosh, Unix - Motif, VMS and probably some other platforms)
  110. .endpar
  111.  
  112. .par
  113. From the same source you created your hypertext database, you can create
  114. a text document with automatic table of contents and index sections!
  115. .endpar
  116.  
  117. .par
  118. Using the RTF target you can prepare your professional documentation
  119. by generating word processors documents, all from the same source!
  120. .endpar
  121.  
  122. Features :
  123.  
  124. .par
  125. Topics, Popups, Links, Keywords, Text Formats, Navigational and
  126. Structural facilities, Target Code insertion, Multiple module files,
  127. Automatic Pascal/C/C++ reference generation, Exception handling,
  128. Multiple file target databases, Graphics, Sound, Groups, Application
  129. Launch, Automatic exports creation, User defined link templates and more.
  130. .endpar
  131.  
  132.  
  133. .par bold on size 15
  134. Contact HyperAct Inc. if you want to purchase the WINTEXT UI library for 
  135. Turbo Pascal programs, and use the help engine window in your pascal
  136. programs.
  137. .endpar
  138.  
  139. .par font 13 bold on
  140. Related Topics :
  141. .endpar
  142. ~Registration~register~
  143. ~Contact~contact~
  144. ~File List~fileList~
  145. ~Credits~credits~
  146. ~Help Engine~helpeng~
  147. ~Help Compiler~helpC~
  148. ~Quick Start~quickStart~
  149. ~Related Products~otherProducts~
  150.  
  151. .endtop
  152.  
  153. ;******************************************************************************
  154. ;                                  register                                   *
  155. ;******************************************************************************
  156. .entry register
  157. .title Registration
  158. .keywords contact register
  159. .list general
  160.  
  161. .ifndef rtfbased
  162. *******************************************************************************
  163. *                 Why Register and registration instructions                  *
  164. *******************************************************************************
  165. .else
  166. .par box normal align center
  167. Why Register and Registration Instructions
  168. .endpar
  169. .endif
  170.  
  171. .par
  172. The Help Engine Development Kit (HLPDK) is a shareware product, if you 
  173. find this product valuable, please register it. 
  174. This section describes the reasons you should register.
  175. .endpar
  176.  
  177. .par
  178. By registering you will receive a complete discussion of the help engine 
  179. features, and many examples of usage. You will receive a diskette with the
  180. latest HLPDK version, and DPMI (DOS protected mode) versions of the help 
  181. compiler and engines!. (The memory version of the help engine can display 
  182. huge databases only in the protected mode version). OS/2 and Windows versions
  183. of the help compiler are also included.
  184. .endpar
  185.  
  186. .par
  187. Your registration will help us to create the next versions of HLPDK, that
  188. will include more options, and features, some of them might even be your
  189. enhancement requests!.
  190. .endpar
  191.   
  192. .par
  193. A point to consider - If you want to create Windows Help source files,
  194. you will have to purchase a word processor that can output RTF files,
  195. the WORD for Windows 2.0 package, for example, is listed at around $500!.
  196. .endpar
  197.  
  198. .par box normal align center
  199. To order your registered copy of HLPDK please do one of the following:
  200. .endpar
  201.  
  202.  1.     Order from HyperAct Inc.:     
  203.  You can order directly from HyperAct Inc.. Please refer to the supplied 
  204.  HLPDK.REG file. Edit it, print it and mail it (with a check) to: 
  205.         HyperAct Inc.,  
  206.         POBox 5517
  207.         Coralville Iowa 52241, U.S.A
  208.  
  209.  2.     Order from PsL:
  210.  You can order from Public (software) Library with your MC, Visa, AmEx 
  211.  or Discover card by calling 800-242-4PsL (from overseas: 713-524-6394) or 
  212.  by FAX to 713-524-6398 or by CompuServe to 71355,470. 
  213.  These numbers are for ordering only. HyperAct Inc. can NOT be reached at those 
  214.  numbers. Please contact HyperAct Inc. directly for any other type of problem 
  215.  (technical or other), information or request.
  216.                                               
  217. .par font 13 bold on
  218. Related Topics :
  219. .endpar
  220. ~Contact~contact~
  221. ~Overview~overview~
  222. .end-entry
  223.  
  224. ;******************************************************************************
  225. ;                                   Contact                                   *
  226. ;******************************************************************************
  227. .entry Contact
  228. .keywords register contact
  229. .list general
  230.  
  231.   Please contact :
  232.  
  233.   HyperAct Inc.,  
  234.   P.O.B 5517
  235.   Coralville IA 52241,
  236.   U.S.A
  237.  
  238. .par italic on
  239. Phone/Fax - (319) 351-8413
  240. .endpar
  241. .par italic on
  242. e-mail address : CompuServe - 76350,333
  243. .endpar
  244.  
  245.   To contact the author directly : 
  246.  
  247. .par italic on
  248. e-mail address : CompuServe - 100274,162
  249. .endpar
  250.  
  251. .par font 13 bold on
  252. Related Topics :
  253. .endpar
  254. ~Regsiteration~register~
  255. ~Overview~overview~
  256. .end-entry
  257.  
  258. ;******************************************************************************
  259. ;                                  fileList                                   *
  260. ;******************************************************************************
  261. .entry fileList
  262. .title HPLDK Distribution File List
  263. .list general
  264.  
  265.  This package contains the following files in the following archives :
  266.  
  267. Archive A :
  268. -----------
  269.   READMEA.HDK    - File List for Archive A.
  270.   HELPC.EXE      - Help Compiler.
  271.   HLPDK.DOC      - This file.
  272.   HELPC.DOC      - Help Compiler documentation
  273.   HLPDK.REG      - Registration file.
  274.   HLPDK.UPG      - Upgrade instructions for registered users.
  275.   HLPDK.HLP      - WinHelp Version of the HLPDK hypertext source.
  276.   THANKS.WAV     - WAV file used by HLPDK.HLP
  277.   HLPDK.INF      - OS/2 IPF Version of the HLPDK hypertext source.
  278.   PROGRAMS.TXT   - HyperAct Inc. shareware products description.
  279.   HELPDEMO.HDF   - Demo Help Project.
  280.   2NDDEMO.HDF    - Demo Help Project - file 2.
  281.   RONP.BMP       - Bitmap used in HLPDK.HDF
  282.  
  283. Archive B :
  284. -----------
  285.   READMEB.HDK    - File List for Archive B.
  286.   HELPENG.EXE    - Help Engine (Native Paradox).
  287.   HE.EXE         - Help Engine (Native Memory).
  288.   HLPDK.HDF      - Help Development Kit hypertext help database source.
  289.   HELPDEMO.HLP   - Demo Help Project file for Windows WinHelp. 
  290.   HLPDK.HDT      - Help Development Kit help database file. (Native Paradox)
  291.   HLPDK.SET      - Help Development Kit help database file.
  292.   HLPDKTOP.DB    - Help Development Kit help database file.
  293.   HLPDKTOP.PX    - Help Development Kit help database file.
  294.   HLPDKLNK.DB    - Help Development Kit help database file.
  295.   HLPDKLNK.PX    - Help Development Kit help database file.
  296.   HLPDKKEY.DB    - Help Development Kit help database file.
  297.   HLPDKKEY.PX    - Help Development Kit help database file.
  298.   MULTI1.HDF     - Multiple file target database demo - 1.
  299.   MULTI2.HDF     - Multiple file target database demo - 2.
  300.   MAKMULTI.BAT   - Demo multiple file target database batch file.
  301.   HDKACT.HLP     - HELPCW Help File.
  302.  
  303. Archive L :
  304. -----------
  305.   READMEL.HDK    - File List for Archive L.
  306.   HDKLIB.DOC     - HLPDK System Library Documentation.
  307.   HDKLIB.HDF     - HLPDK System Library main file.
  308.   RTFLIB.HDF     - RTF common functions extension library.
  309.   VWRLIB.HDF     - MMViewer Extension Library for 256 color bitmaps.
  310.   IPFLIB.HDF     - System extension library component. (OS/2)
  311.   WWWLIB.HDF     - HTML Extension Library.
  312.   TESTLIB.HDF    - A Small test for the library - Source.
  313.   TESTLIB.HLP    - A Small test for the library - WinHelp format.
  314.   PRS.BMP        - A Bitmap used in the test.
  315.   RANCO.AVI      - A Short Video Sequence featuring Ranco The Great.
  316.   CREDITS.WAV    - Credits in vocal, for the MOVIE demo help database.
  317.   INTRO.WAV      - Vocal introduction to the MOVIE demo help database.
  318.   MOVIE.HDF      - A Multimedia Help Database demo source.
  319.   MOVIE.HLP      - A Multimedia Help Database demo - WinHelp version.
  320.  
  321. Note : In some cases all files may be in one archive.
  322.  
  323. .par
  324. The registered version is shipped in one archive and includes some additional 
  325. files.
  326. .endpar
  327.  
  328. .par
  329. The following files are included with the Registered and Advanced versions,
  330. and are not included in the shareware evaluation package :
  331. .endpar
  332.  
  333.   HELPCX.EXE     - Protected Mode Help Compiler.
  334.   HELPCO.EXE     - OS/2 Mode Help Compiler.
  335.   HELPCW.EXE     - Windows Mode Help Compiler.
  336.   HELPENGX.EXE   - Protected Mode Help Engine - Paradox Native Mode.
  337.   HEX.EXE        - Protected Mode Help Engine - Memory Native Mode.
  338.   README.HDK     - Registered Version README.
  339.   DPMI16I.OVL    - DPMI overlay module (Borland).
  340.   RTM.EXE        - Borland DPMI Run Time Module.
  341.   RTMRES.EXE     - Resident RTM version.
  342.   DPMIINST.EXE   - DPMI configuration file.
  343.   DPMILOAD.EXE   - DPMI Loader.
  344.   DPMIUSER.DOC   - Notes about using Borland DPMI services.
  345.   BIVBX10.DLL    - HelpCW Support DLL.
  346.   PXENGWIN.DLL   - HelpCW Support DLL.
  347.   MHGA200.VBX    - HelpCW Support VBX.
  348.   BWCC.DLL       - HelpCW Support DLL.
  349.   CTL3DV2.DLL    - HelpCW Support DLL.
  350.   MH300RUN.DLL   - HelpCW Support DLL.
  351.  
  352. .par font 13 bold on
  353. Related Topics :
  354. .endpar
  355. ~Overview~overview~
  356. ~Quick Start~quickStart~
  357. .end-entry
  358.  
  359. ;******************************************************************************
  360. ;                                   Credits                                   *
  361. ;******************************************************************************
  362. .entry Credits
  363. .list general
  364.  
  365. .par
  366. .ifdef windows
  367. ~RonP~RonPicture;left~ HLPDK, helpC, The Help Engines, NewsDB, IL2HDK, NG2HDK, RTF2HDK, RC2HDK and
  368. .else
  369. HLPDK, helpC, The Help Engines, NewsDB, IL2HDK, NG2HDK, RTF2HDK, RC2HDK and
  370. .endif
  371. other products, were written by Ron Loewy. These products are distributed 
  372. worldwide by HyperAct Inc..
  373. .endpar
  374.  
  375. .par
  376. HELPENG, helpC were written using Turbo Pascal 6.0, and Borland Pascal 7.0,
  377. Paradox Engine 2.0, and Paradox Engine 3.0, 3.01. 
  378. (Trademarks of Borland International).
  379. .endpar
  380.  
  381. .par
  382. Windows, Microsoft, HC and Quick Help are trademarks or copyrights
  383. of Microsoft Corp.
  384. .endpar
  385.  
  386. .par
  387. The HELPENG program was written using the WINTEXT UI library, 
  388. (c) 1991,93 Loewy Ron.
  389. .endpar
  390.  
  391. THELP, HL and TVHC are Trademarks or copyrights Borland International.
  392.  
  393. POPHELP is a copyright of TurboPower Software.
  394.  
  395. TVHC support, and other ideas were suggested by MunLeong Chan.
  396.  
  397. .par
  398. Parts of the Help Engines were generated using Ron Loewy's WTGEN and dbGen
  399. CASE code generators.
  400. .endpar
  401.  
  402. .par
  403. Parts of the Help Compiler were generated using Ron Loewy's dbGen database 
  404. code generator.
  405. .endpar
  406.  
  407. .par
  408. Yaniv Golan helped me with beta-testing, debugging and suggestions.
  409. He is also the  author of the HPCHDK and POPHDK packages.
  410. .endpar
  411.  
  412. .par
  413. John Murphy notified me of the paragraph formatting difficulties that
  414. lead to the .PARAGRAPH .END-PARAGRAPH formatting capabilities.
  415. .endpar
  416.  
  417. DESQview/X is a trademark of Quarterdeck Office Systems.
  418.  
  419. .par
  420. MDVXHELP is a copyright (1992) of Daniel J. Bodoh. I have used his
  421. excelent documentation of DESQview/X help format to generate code
  422. to this environment.
  423. .endpar
  424.  
  425. .par
  426. The HC31 problem with characters with ordinal values biggen than 127
  427. was solved thanks to Mr. Lars Fosdal of Norway.
  428. .endpar
  429.  
  430. OS/2 is a registered trademark of International Bussiness Machines.
  431.  
  432. .par
  433. The Text Cursor restore problem in the help engines was reported by Prof.
  434. Timo Salmi of the Univ. of VAASA, Finland.
  435. .endpar
  436.  
  437. .par
  438. D.J. Murdoch suggested the Cross Reference Report enhancements, and WinHelp
  439. Go To Search list box title problem.
  440. .endpar
  441.  
  442. Word for Windows is a trademark of Microsoft corp.
  443.  
  444. WordPerfect, WordPerfect for Windows are trademarks of WordPerfect corporation.
  445.  
  446. Lotus, AMI PRO are trademarks of Lotus corp.
  447.  
  448. Reuben Halevi from HyperAct Inc. did a lot to make this product real.
  449.  
  450. .par
  451. Slren Pingel Dalsgaard notified me of the small scroll box bug in helpeng, as
  452. well as some spelling mistakes in helpC.
  453. .endpar
  454.  
  455. .par
  456. TurboPower Software Big Collections are used as a basis to the huge memory 
  457. tables used in the help compiler and engine.
  458. .endpar
  459.  
  460. Peter Sawatzki's JanusW dialog boxes are used in the HelpCW program.
  461.  
  462. The Borland Visual Control Pack gauge control is used in the HelpCW program.
  463.  
  464. The Borland Pascal 7.0 C'T' magazine patch was used in the HELPCO program.
  465.  
  466. .par font 13 bold on
  467. Related Topics :
  468. .endpar
  469. ~Overview~overview~
  470. .end-entry
  471.  
  472. ;******************************************************************************
  473. ;                                 quickStart                                  *
  474. ;******************************************************************************
  475. .entry quickStart
  476. .title Quick Start
  477. .keywords operation
  478.  
  479. From the command line enter HELPC HELPDEMO to compile the demo help database.
  480.  
  481. .par
  482. After the compilation process is ended, enter HELPENG HELPDEMO to browse the
  483. demo help database.
  484. .endpar
  485.  
  486. If you want to compile for windows :
  487.  
  488. from the command line enter HELPC HELPDEMO /W31
  489. and after that HC31 HELPDEMO
  490. (HC31 is the Microsoft Help Compiler)
  491. .par
  492. from windows, open the HELPDEMO.HLP file from the windows help engine.
  493. (Notice - if you do not have the HC help compiler from windows, we have
  494. included a compiled version of HELPDEMO (HELPDEMO.HLP) so you will be
  495. able to feel the quality of the output that can be generated, and decide
  496. if you want to purchase the HC31 program (Included with the SDK, BC++, 
  497. TPW, BP and probably some other packages), or download it from one of the
  498. sites Microsoft had uploaded it to).
  499. .endpar
  500.  
  501. .par
  502. If you use windows 3.0, or want your help file to be compatible with
  503. WinHelp 3.0 use :
  504. .endpar
  505.         HELPC /W30 HELPDEMO
  506.         HC HELPDEMO
  507.  
  508. To compile for THELP use : 
  509.         HELPC /TH+ HELPDEMO
  510.         HL -x -e100 -p -i -oHELPDEMO.TPH HELPDEMO.HL
  511.  
  512. To compile for QuickHelp : 
  513.         HELPC /QH+ HELPDEMO
  514.         HELPMAKE -e15 -oHELPDEMO.QH HELPDEMO.SRC
  515.  
  516. To compile for TVHC :
  517.         HELPC /TV+ HELPDEMO
  518.         TVHC HELPDEMO.TXT
  519.  
  520. To compile for POPHELP :
  521.         HELPC /PH+ HELPDEMO
  522.         MAKEHELP /Q HELPDEMO
  523.  
  524. To compile for DESQview/X :
  525.         HELPC /XD+ HELPDEMO
  526.         MDVXHELP HELPDEMO.HLP @HELPDEMO.LST
  527.         COPY HELPDEMO.HLP d:\DVX\HELP
  528.  
  529. To compile for Native Mem Format :
  530.        HELPC /MT+ HELPDEMO
  531. (Use HE HELPDEMO to view that database).
  532.  
  533. To compile for IPF (OS/2) format :
  534.        HELPC /OS2 HELPDEMO 
  535.        Switch to an OS/2 session.
  536.        IPFC /INF HELPDEMO
  537. (Use the VIEW Command to browse the database).
  538.  
  539. To compile for the Microsoft Multimedia Viewer 2.0 :
  540.        HELPC /MMV HELPDEMO
  541.        Open the MMViewer compiler (WMVC.EXE)
  542.        File|Open HELPDEMO.MVP
  543.        Compile (F5)
  544. (Use the VIEWER2.EXE program to browse the database).
  545.  
  546. To create a HTML database for use with a WWW server :
  547.  
  548.   Define the .ROOTNODE and .ROOTPATH of your server in the helpdemo source.
  549.   HELPC /WWW HELPDEMO
  550.   Copy the *.HTM files to the server's path.
  551.  
  552. To create a text document with table of contents, glossary and index :
  553.        HELPC /TXT HELPDEMO
  554.  
  555. To create a word processor document with table of contents, 
  556. glossary and index :
  557.        HELPC /RTF HELPDEMO
  558.        import helpdemo.rtf to your word-processor, and update fields.
  559.        (e.g. Microsoft WinWord : File|Open to open the document
  560.                                  Answer Yes to convert from Rich Text Format
  561.                                  Press F9 to update embedded format fields
  562.                                  somewhere in the first page (after the 
  563.                                  Table Of Contents title), and in the last 
  564.                                  page (after the index title).)
  565. .par font 13 bold on
  566. Related Topics :
  567. .endpar
  568. ~Overview~overview~
  569. ~File List~filelist~
  570. .end-entry
  571.  
  572. ;******************************************************************************
  573. ;                                   helpeng                                   *
  574. ;******************************************************************************
  575. .entry helpeng
  576. .title The Help Engine
  577. .keywords operation
  578.  
  579. .par
  580. To start the help engine program enter HELPENG on the command line, and 
  581. choose the help database you want to view from the list box. Use the Tab key
  582. to cycle between hot-link words, and press Enter to go to that link.
  583. .endpar
  584.  
  585. .par
  586. If you know the name of the SET file of the database you want to activate, you
  587. can enter it on the command line, and the help engine will display it.
  588. .endpar
  589.  
  590. .par
  591. If you have a mouse, you can use it to point at the hi-lighted links, and 
  592. activate them by pressing the left mouse button.
  593. .endpar
  594.  
  595. .par
  596. Press the ALT-T key combination to choose from a list of TOPICS in the 
  597. database, Press ALT-B to go back to the previous displayed TOPIC, Press
  598. ALT-X to exit the help engine.
  599. .endpar
  600.  
  601. The exit command can be given by pressing the right mouse button.
  602.  
  603. .par
  604. Use F10 to open the menu bar, and use the arrow keys to navigate the 
  605. options. When you find the option you are interested in, Use the Enter
  606. key to execute it, or the Esc key to cancel. The menu bar can be navigated
  607. using the mouse as well.
  608. .endpar
  609.  
  610. .par
  611. To create a new help database please refer to the ~HELPC~helpc~ documentation
  612. file.
  613. .endpar
  614.  
  615. .par
  616. If you want to use the Native Mem Format Databases, Please use the supplied
  617. HE.EXE program. 
  618. .endpar
  619.  
  620. .par font 13 bold on
  621. Related Topics :
  622. .endpar
  623. ~Trouble Shooting~Trouble~
  624. ~Overview~overview~
  625. .end-entry
  626.  
  627. ;******************************************************************************
  628. ;                                   Trouble                                   *
  629. ;******************************************************************************
  630. .entry Trouble
  631. .title Trouble Shooting
  632. .keywords operation
  633.  
  634. .par
  635. If you receive some kind of an error message while using the help development
  636. kit please refer to this section.
  637. .endpar
  638.  
  639. tableOps: xxxx error message :
  640. .par
  641. This message is generated by the Paradox Engine if an internal error occurs,
  642. if you receive a message that is not understood (e.g. Table is busy), 
  643. please try one of the following :
  644. .endpar
  645.  1. Try running the Help Compiler or the Help Engine with another input and 
  646.     notice if the problem exists, if it does, turn to the next entry,
  647.     otherwise try to see what the difference between the inputs is.
  648.  2. Check your free memory, try to move some TSR's from memory, or use the
  649.     protected mode compiler/engine available with the registered version.
  650.  3. Check if you have loaded dos SHARE program, it is advised to use SHARE
  651.     with programs that use the Paradox Engine. If you receive a table busy
  652.     error, try to see if you have another program that uses the same table 
  653.     in another session (Windows/DESQview etc..).
  654.  4. PANIC - Please contact the distibuter/author for additional help.
  655.  
  656. Microsoft's HC31 help compiler will generate a error in RTF file error :
  657.  
  658.  1. Re-compile using helpC 4.0+. This should solve the problem, if the problem
  659.     still exists - please try steps 2 and 3, and notify the author. 
  660.  2. Use a binary disk editor to look at the character at the position x - 1
  661.     in the RTF file (where x is the error position reported by HC31).
  662.  3. Try to replace that charqacter from a special PC oem character to a 
  663.     "standard" ascii character (such as *). If the problem still occurs,
  664.     please contact HyperAct Inc./The author, otherwise - you probably came 
  665.     accross a character that HC31 can not handle. In that case - try using
  666.     HC300b (the one that generates WinHelp 3.0 format), or delete these 
  667.     characters from your source HDF file.
  668.  
  669. Borland's HL help linker will generate a FE02: Out Of Memory error :
  670.  1. Re-compile using helpC V3.0+, to include ;INDEX directives after the
  671.     screen's definitions.
  672.  
  673. Borland's HL help linker will complain about undefined context numbers :
  674.  1. You probably have a contents.h file in the current directory, that hl
  675.     tries to use to bind the help topics to Borland's IDE on-line help,
  676.     try renaming this file, and re-compile with HL.
  677.  
  678. helpC will not create the database when compiling to Native Mem (/MT+) :
  679.  1. Try compiling with report generation on (/R+) to Native Paradox
  680.     (/PX+) format. If there are errors, consult the HELPC.LST file, fix 
  681.     them, and re-try.
  682.  2. If the database is BIG, you might not have enough memory - Remember that
  683.     Native Mem tables are generated in memory. You will have to use the
  684.     HelpCX protected mode compiler (Available with the registered version).
  685.  
  686. HelpEng/HE will complain on an old-database when trying to open a help
  687. database with it :
  688.  1. Re-Compile the database using helpC.
  689.  
  690. HelpEng/HE will complain on un-supported database format, when trying to
  691. open a database :
  692.  1. HelpEng can not display Native Mem databases, and HE can not display
  693.     Native PX databases. Use the other help engine supplied.
  694.  
  695. HE will not be able to open a Native Mem database :
  696.  1. Use the protected mode HEX help engine. (Available for registered users).
  697.  
  698. Where is HL - Borland's Help Linker :
  699.  1. HL is not included with Borland C++ or Borland Pascal, Borland sells an
  700.     additional package called Borland Open Architecture (and Borlad OA for 
  701.     Pascal) that include among other things - the THELP help linker.
  702.  
  703. Windows HC run's out of memory :
  704.  1. Use HCP - the protected mode Help Compiler. Look for HCP505.ZIP on
  705.     ftp.microsoft.com, or CIS:WINSDK/WINHELP.
  706.  
  707. Windows compiled databases do not start with the OVERVIEW screen :
  708.  1. The Windows Help Compiler has a strange bug when it does not have enough
  709.     memory or diskspace, it sometimes does not display any information, does
  710.     not compress the database, and ignores the contents screen defined in the
  711.     HPJ file.
  712.  
  713. .par
  714. We have encountered some users that ran into problems, because they did 
  715. not use the dos SHARE program. We advise that you will always load the 
  716. SHARE program in your AUTOEXEC.BAT file.
  717. .endpar
  718.  
  719. .par font 13 bold on
  720. Related Topics :
  721. .endpar
  722. ~Overview~overview~
  723. ~Help Engine~helpeng~
  724. ~Help Compiler~helpC~
  725. .end-entry
  726.  
  727. ;******************************************************************************
  728. ;                                    helpC                                    *
  729. ;******************************************************************************
  730. .entry helpC
  731. .title Help Compiler
  732. .keywords operation
  733.  
  734. .par
  735. The helpC help compiler is a dos command line program that receives a 
  736. help definition file (.HDF) and produce a help database. 
  737. .endpar
  738.  
  739.   The helpC command line is :
  740.  
  741.  HELPC source.fil [/NT:topic-table-name]
  742.                   [/NL:link-table-name] 
  743.                   [/ND:data-file-name] 
  744.                   [/NK:keywords-table-name] 
  745.                   [/D:conditional-define]
  746.                   [/ED=P|C|+]
  747.                   [/EL=x]
  748.                   [/FC+]
  749.                   [/EA+]
  750.                   [/TN+]
  751.                   [/Ipath]
  752.                   [/R+]  [/ST-] [/CS+] [/EP+] [/WD-] [/RM-]
  753.                   [/W+]  [/W30] [/W31] [TH+] [/QH+] [/TV+] [/PH+] [/XD+]
  754.                   [/PX+] [/MT+] [/OS2] [/TXT] [/RTF] [/PP+] [/MMV]
  755.                   [/WWW]
  756. .par
  757. When the target of the compiler is one of the native help engines
  758. the output of the compiler is a set data file called source.SET, that
  759. includes the names of the other help database components. 
  760. .endpar
  761.  
  762. .par
  763. Please Notice - if the /W+ /W30 or /W31 switch is defined, the compiler 
  764. will generate a .HPJ and .RTF files that can be used with the Microsoft 
  765. HC (v3.00b) or HC31 help compiler, and output a .HLP windows help file!. 
  766. .endpar
  767.  
  768. .par
  769. By default the help compiler does not produces a help cross reference 
  770. report on the topics/links used in the database, if the /R+ switch is set, 
  771. a cross-reference report will be generated, and database integrity indicators 
  772. will be given. Notice, however, that with the /R+ switch helpC is much
  773. slower than with /R-.
  774. .endpar
  775.  
  776. .par
  777. IMPORTANT - Scan the output cross reference report for links defined, that
  778. are not defined as topics!
  779. .endpar
  780.  
  781. .par
  782. Notice - An additional switch is available that instructs the help compiler
  783. to indicate it's parse and code generation progress. Use the /EP+ switch to
  784. see that the helpC compiler is active. Please understand that the compile
  785. process can take a long time, on complex help databases. This switch does
  786. nothing more that ensure to you that the help compiler is alive. 
  787. .endpar
  788.  
  789. .par
  790. The /ST switch defines if the topic name defined in the .TOPIC command
  791. can include embeded spaces. By default this switch is set to /ST- (No
  792. embedded spaces).
  793. .endpar
  794.  
  795. .par
  796. The /CS switch turns Topics and Links case sensativity to ON. Use this
  797. switch with care - Only if you must have a lower/mixed case index in THELP
  798. or POPHELP use this switch. Notice that help databases that compile fine
  799. with case sensativity set to off, might fail to do so in case sensativity
  800. on. By deafult this switch is set to off (-).
  801. .endpar
  802.  
  803. .par
  804. The /XD switch generates code to the MDVXHELP help compiler, available
  805. free in the file DVXHLP10.ZIP on the Internet. When this switch is given,
  806. a set of cover and section files is generated, as well as a response
  807. file that should be used to compile the help database.
  808. .endpar
  809.  
  810. .par
  811. The /OS2 switch generates IPF source code. You must compile the generated code 
  812. with IPFC, from within an OS/2 session (window or full screen).
  813. .endpar
  814.  
  815. .par
  816. The /WD switch controls Warning Display. By default Warning Display is On, if
  817. you do not want to see the Warnings issued by the compiler when a topic name 
  818. or link are found to be incompatible with the target source, and helpC 
  819. translate them to be syntax compatible with the target.
  820. .endpar
  821.  
  822. .par
  823. Use the /RTF switch to create a word-processor ready RTF file, import this
  824. file (and update the fields e.g.- F9 in WinWord) to create a professional
  825. formatted documentation from the same source code!.
  826. .endpar
  827.  
  828. .par
  829. Use the /TXT switch to create a text file document from your .HDF source.
  830. With this feature you can create on-line help and printed documentation
  831. from the same source!.
  832. .endpar
  833.  
  834. .par
  835. The /RM- switch uses disk cross-reference report tables. Usage of this 
  836. option will allow the creation of cross-reference report for huge databases.
  837. This options will slow the creation of reports, use it only for databases
  838. so big that the report can not be generated using memory tables.
  839. .endpar
  840.  
  841. .par
  842. The /ED= switch creates the external references (if any are defined) in one
  843. of the following formats : /ED=P (Default) creates the external definitions
  844. in a pascal unit, /ED=C creates the external definitions in a C header 
  845. file, and /ED=+ creates a C++ header file.
  846. .endpar
  847.  
  848. .par
  849. The /EL= switch sets the Error Level used. This switch can be overriden
  850. by the .ERRORLEVEL statement. The acceptable error levels are :
  851. .endpar
  852.  
  853.       0    No Check  - (Default) - No action is taken.
  854.       1    Trap      - The link is replaced to a special topic named ERROR.
  855.       2    Strip     - The link is replaced by the Text part only.
  856.       3    Delete    - The text and link parts are deleted.
  857.       9    Abort     - helpC will abort with an error message, indicating the 
  858.                        line number.
  859. .par
  860. Please refer to the ~Exception Handling~exceptHandle~ section below about helpC error
  861. processing.
  862. .endpar
  863.  
  864. .par
  865. The /FC+ switch forces topic collection, even if the error level is 0, that
  866. does not require collection.
  867. .endpar
  868.  
  869. .par
  870. Use the /PP+ switch to create an export file, to be used in multiple database
  871. target files projects.
  872. .endpar
  873.  
  874. .par
  875. The /EA+ switch is used to export all topics in a database, during a 
  876. PreProcess target generation, compared to exporting only topics that
  877. have the .EXPORT attributes.
  878. .endpar
  879.  
  880. .par
  881. The /MMV switch is used to generate Microsoft Multimedia Viewer 2.0 code,
  882. You must use the WMVC.EXE program that came with your copy of the  Multimedia
  883. Publishing ToolKit (MM PTK) to compile this code.
  884. .endpar
  885.  
  886. .par
  887. The /WWW switch is used to generate World Wide Web HTML (Hypertext Markup 
  888. Language) sources, for use in the internet distributed hypertext database.
  889. .endpar
  890.  
  891. .par
  892. If the /TN+ switch is used, Topics are collected to the Table Of Contents
  893. table, and the .INSERT TOC command can be used. If a database has a .INSERT
  894. TOC with the /TN+ switch not specified, the compiler will stop and complain.
  895. .endpar
  896.  
  897. .par
  898. The /I switch is used to set an "include" path, to search for .include files.
  899. With this switch the HLPDK library does not need to be duplicated to each
  900. help project directory. (e.g. /IC:\HLPDK\LIB will set the include file to the
  901. C:\HLPDK\LIB directory.)
  902. .endpar
  903.  
  904. .par font 13 bold on
  905. Related Topics :
  906. .endpar
  907. ~Overview~overview~
  908. ~Command Line~commandline~
  909. ~Help Engine~helpeng~
  910. ~Technical Documentation~techdoc~
  911. .end-entry
  912.  
  913. ;******************************************************************************
  914. ;                                 commandline                                 *
  915. ;******************************************************************************
  916. .topic commandline
  917. .title Command Line
  918. .keywords operation
  919.  
  920. .par
  921. The compiler switches are defined on the command line. These switches can
  922. be placed before and after the source file name. The compiler will look for
  923. a file named HELPC.CFG in the current directory, and process it before any
  924. command line switches are processed. 
  925. .endpar
  926.  
  927. .par
  928. Switches on the command line will over-ride switches set before them, on the
  929. command line or in one of the lines of the response options file(s).
  930. .endpar
  931.  
  932. Response option files can be specified by prefixing their name with a @ sign.
  933.  
  934.  
  935.  Examples :
  936.  
  937.  If our HELPC.CFG file, in the current directory is :
  938.  
  939. /W31
  940. /R-
  941.  
  942.  And we compile using HELPC HELPDEMO
  943.  
  944.  The helpdemo.hdf file will be compiled, with the target set to WinHelp 3.1
  945.  and no cross-reference report.
  946.  
  947.  Compile using HELPC HELPDEMO /r+
  948.  
  949.  Will create WinHelp 3.1 sources, but a report will be generated.
  950.  
  951.  Compile using HELPC /w- HELPDEMO
  952.  
  953.  Will generate native format help database, no report is generated.
  954.  
  955.  If we have a file called MYSWITCH.CFG with the following lines :
  956.  
  957. /TH+
  958. /ST-
  959. /CS+
  960.  
  961.  And we compile using HELPC @MYSWITCH.CFG HELPDEMO
  962.  
  963.  A THELP source, using Long Topic Names, with case sensitivity will be 
  964.  generated, no cross reference report is generated. (HELPC.CFG contains /r-)
  965.  
  966. .par font 13 bold on
  967. Related Topics :
  968. .endpar
  969. ~Overview~Overview~
  970. ~Help Compiler~helpc~
  971.  
  972.  
  973. .end-topic
  974.  
  975. ;******************************************************************************
  976. ;                                   techDoc                                   *
  977. ;******************************************************************************
  978. .entry techDoc
  979. .title Technical Documentation
  980. .keywords programming
  981.  
  982. .par
  983. The Help Engine database is a combination of text that is read by the user,
  984. and a Topic and Links database that allows the user to view the topics
  985. he is interested in, using hyper-text methods.
  986. .endpar
  987.  
  988. .par
  989. This document describes the HLPDK language syntax, helpC compiler operation
  990. and the native databases structure.
  991. .endpar
  992.  
  993. .par font 13 bold on
  994. Related Topics :
  995. .endpar
  996. ~Help Compiler~helpC~
  997. ~Help Engine~HelpEng~
  998. ~Help Definition Format~hdf~
  999. ~Native Format Structure~nativeFormat~
  1000.  
  1001. .end-topic
  1002.  
  1003. ;******************************************************************************
  1004. ;                                nativeFormat                                 *
  1005. ;******************************************************************************
  1006. .topic nativeFormat
  1007. .title Native Database Structure
  1008. .keywords programming
  1009.  
  1010.   Each help database is built of 5 components : 
  1011.  
  1012.  1. Help Data File    - this file contains the raw text data.
  1013.  2. Topic Index       - a database table that contains the topic names, and
  1014.                         the references to the topics in the Data File.
  1015.  3. Links Index       - a database table that contains the list of links 
  1016.                         defined for each topic, and positional data.
  1017.  4. Keywords Index    - a database table that contains the list of keywords,
  1018.                         and the topics that have these keywords.
  1019.  5. Set Data File     - a database configuration file that contains the
  1020.                         names of the 3 components defined above, and some 
  1021.                         additional information.
  1022.  
  1023. .par
  1024. Version 1.x is the bare-bones version that includes only the basic
  1025. operations needed from a hyper-text database, this version is implemented
  1026. using the Paradox Engine V3.0 to manage the Topic and Link index tables.
  1027. .endpar
  1028.  
  1029. .par
  1030. Version 2.x has a new field in the topic table - the title field, help
  1031. databases that were compiled with V1.x will not be executed by version
  1032. 2.x, they will have to be re-compiled!.
  1033. .endpar
  1034.  
  1035. .par
  1036. Version 3.x fields have different length - the databases have to be 
  1037. re-compiled.
  1038. .endpar
  1039.  
  1040. .par
  1041. Version 5.0+ has a new entry in the help set file, database have to be
  1042. re-compiled, or the value 128 should be added in the last line of the help
  1043. set file, and the version number should be changed to 5.0.
  1044. .endpar
  1045.  
  1046. .par
  1047. Version 6.0+ has added the keyword support - a new database table is added,
  1048. and a new set format is defined. Help databases will have to be re-compiled
  1049. for Natice targets.
  1050. .endpar
  1051.  
  1052. .par
  1053. In Version 7.0 the title field has been expanded once more - to 70 
  1054. characters. Help databases will have to be re-compiled.
  1055. .endpar
  1056.  
  1057. .par
  1058. In Version 8.0 the tType field was added to the Topics database. Old databases
  1059. will have to be re-compiled.
  1060. .endpar
  1061.  
  1062. .par
  1063. The format of the help database is released to the public domain, if
  1064. you implement a database viewer on this database structure, I would be
  1065. happy to receive a copy ..
  1066. .endpar
  1067.  
  1068. .par font 13 bold on
  1069. Related Topics :
  1070. .endpar
  1071. ~Help Compiler~helpC~
  1072. ~Help Engine~HelpEng~
  1073. ~Help Definition Format~hdf~
  1074. ~Topic Index Format~tif~
  1075. ~Links Index Format~lif~
  1076. ~Keywords Index Format~kif~
  1077. ~Set File Format~sff~
  1078.  
  1079. .end-entry
  1080.  
  1081. ;******************************************************************************
  1082. ;                                     hdf                                     *
  1083. ;******************************************************************************
  1084. .entry hdf
  1085. .title Help Definition Format
  1086. .keywords programming
  1087. .list hdf
  1088.  
  1089.   The help definition file format is as follows :
  1090.  
  1091. | remarks ...
  1092. | remarks ...
  1093. | 
  1094. | .ENTRY topic-name
  1095. | [.TITLE optional title for topic]
  1096. | [.TITLEATTR paragraph attributes]
  1097. | [.KEYWORDS optional keywords for topic]
  1098. | [.GROUPS group1 [group2 ..]]
  1099. | [.LIST optional browse list for topic]
  1100. | [.ACTION stuff to do when topic is entered]
  1101. | [.EXPORT]
  1102. | [.TEXTATTR paragraph attributes]
  1103. | topic text and link reference .. 
  1104. | topic text and link reference .. 
  1105. | topic text and link reference .. 
  1106. | topic text and link reference .. 
  1107. | .END-ENTRY 
  1108. | 
  1109. | remarks ...
  1110. | 
  1111. | 
  1112. | .ENTRY topic2-name
  1113. | [.KEYWORDS keyword1 keyword2 ..]
  1114. | [.GROUPS group3 [group2 ..]]
  1115. | [.PARAGRAPH [paragraph attributes]]
  1116. | topic 2 text and link reference .. 
  1117. | topic 2 text and link reference .. 
  1118. | topic 2 text and link reference .. 
  1119. | [.END-PARAGRAPH]
  1120. | additional topic2 text ...
  1121. | .END-ENTRY 
  1122. |
  1123. | .POPUP popup-name
  1124. | [.TITLE optional title for popup]
  1125. |   definition for some reference
  1126. |   ...
  1127. | .END-POPUP
  1128.  
  1129.   As can be seen - lines between the .ENTRY and .END-ENTRY keywords are
  1130.  the lines processed by the help compiler, to create the help database, 
  1131.  every other line is considered a remark, and is not parsed or evaluated by
  1132.  the help compiler.
  1133.  
  1134.   The topic text and link reference lines are simple text lines, with
  1135.  special link marks.
  1136.  
  1137.   A sample will provide the details :
  1138.  
  1139. This is a text help line that includes one ~~link~~link-topic-name~~ in it.
  1140.  
  1141.   This line will be displayed in the help engine program as :
  1142.  
  1143. This is a text help line that includes one link in it.
  1144.  
  1145.   The word "link" will be in a different color then the rest of the line, 
  1146.  to indicate that this is a link. If the user hi-lights the link, and
  1147.  presses Enter (or points the mouse cursor and clicks), the help engine will
  1148.  look for a topic called "link-topic-name", and display it.
  1149.  
  1150.   Browse the HELPDEMO.HDF file for a demo of a help database definition file.
  1151.  
  1152.  Notes :
  1153.  
  1154.  1. The keywords .TOPIC and .END-TOPIC can be used instead of .ENTRY and
  1155.   .  .END-ENTRY respectively.
  1156.  
  1157.     An equivalent pair of keywords are .TOP and .ENDTOP .
  1158.  
  1159.     You can use .EXT-TOPIC instead of .TOPIC/.ENTRY etc.. - topics created
  1160.     with that statement are the same as regular topics, only - an external
  1161.     reference is created for them to be linked to a pascal/C/C++ program.
  1162.  
  1163.  2. Keywords are NOT case sensitive. (.topic = .TOPIC = .eNTry)
  1164.  
  1165.  3. The .TITLE keyword is optional. If no title is defined, the topic name
  1166.     is used as a title. The .TITLEATTR keyword is used to describe the
  1167.     title text attributes. The syntax is the same as the .PARAGRAPH text
  1168.     attributes. Please refer to the Text Attributes section below for further
  1169.     discussion of the optional paragraph attributes. In the WinHelp and
  1170.     Multimedia targets, the title can have links in it, so graphic and
  1171.     inter-paragraph text attributes can be applied.
  1172.  
  1173.  
  1174.  4. If you want the ~~ sign to appear in your help database, use ~~~~ in your
  1175.     help source file. (e.g. "This is a ~~~~" will be "This is a ~~" in the final
  1176.     help database.).
  1177.  
  1178.  5. The Optional .PARAGRAPH and .END-PARAGRAPH commands in the help topic text,
  1179.     specify the start and the end of a paragraph. This feature is currently 
  1180.     supported only for MMViewer, WWW, WinHelp, RTF and IPF sources. This feature
  1181.     is important if you want to create long paragraphs that will wrap correctly
  1182.     when a user resizes the help window. Please refer to the 
  1183.     ~Text Attributes~textAttr~ section below for further discussion of the optional 
  1184.     paragraph attributes.
  1185.  
  1186.     The .PAR and .ENDPAR keywords can be used instead of the .PARAGRAPH 
  1187.     and .END-PARAGRAPH keywords.
  1188.  
  1189.  6. When a .PARAGRAPH is issued, a .END-PARAGRAPH MUST be specified at the
  1190.     end of the paragraph. These commands must appear as the first words in
  1191.     a line. The text after the .PARAGRAPH command is NOT part of the text 
  1192.     of the help topic, but paragraph text attributes can be specified there.
  1193.  
  1194.  
  1195.  7. The optional .KEYWORDS command can appear after the .TITLE command
  1196.     (If there is one), or the .TOPIC header (otherwise), Use this command
  1197.     to help the user search for sets of topics that are connected to a 
  1198.     specific keyword. The syntax of this command is :
  1199.     .KEYWORDS keyword-1 keyword-2 ... 
  1200.     Multiple .KEYWORDS lines are allowed, if there are a lot of KEYWORDS,
  1201.     that will not fit on a single line, multiple .KEYWORDS lines can be
  1202.     used. (NewsDB - The usenet hypertext generator uses that feature).
  1203.  
  1204.  8. .POPUP and .END-POPUP (or .ENDPOP) are used to define popup topics that 
  1205.     are displayed on the same screen as the original topic that includes the
  1206.     link to them. Popup entries allow the user to consult a glossary, and 
  1207.     not lose the topic he was reading. Popups are supported in the WinHelp,
  1208.     OS/2 IPF, Native PX/Mem and MMViewer formats. In the other formats Popups are 
  1209.     used as standard topics.
  1210.  
  1211.  9. In the Text/RTF targets .POPUP entries will be automatically included in a 
  1212.     Glossary file that you can add as an appendix to your documentation.
  1213.  
  1214. 10. The .GROUPS statement associate a topic with several groups, you can 
  1215.     create topics with menus to groups of other topics using the statement
  1216.     ".INSERT GROUP group-name" in your topic text. Please refer to the 
  1217.     ~Groups~GroupsDoc~ section of this document for additional discussion of this
  1218.     function.
  1219.     Multiple .GROUPS lines are allowed, if there are a lot of GROUPS,
  1220.     that will not fit on a single line, multiple .GROUPS lines can be
  1221.     used.
  1222.  
  1223. 11. The .LIST attribute associates a topic to a browse sequence, in this
  1224.     name. The topic will be after the previous topic that belongs to this
  1225.     list, and before the next topic that belongs to this list. The list
  1226.     browse sequences are currently supported in the WinHelp and MMViewer
  1227.     targets only.
  1228.  
  1229. 12. Graphic support is available by using a Graphic Link, a Graphic Link,
  1230.     is a link that has the following format :
  1231.     ~~Text to display if not a graphic target~~graphic-name~~
  1232.     Where graphic-name is the name of a graphic object defined with the
  1233.     .GRAPHIC statement. Please refer to the ~Graphics~graphics~ Section below for more
  1234.     information.
  1235.  
  1236. 13. If the .EXPORT attribute is specified, helpC will automatically create
  1237.     a reference to the topic in an export file. This function can be useful
  1238.     when you create a multiple file target database. This command can be very
  1239.     useful when you have to create a complex multi file database, and use a
  1240.     'make' utility to maintain the project. For more information about this
  1241.     attribute, please refer to the ~Complex Projects~complexProj~ section below.
  1242.  
  1243. 14. Sound support is available by using a Sound link. This link will play a 
  1244.     sound file, when the user clicks the link. The link has the following
  1245.     format :  ~~Text-That-Will-Appear~~soundLinkName~~
  1246.     Where Text-That-Will-Appear will be displayed on the screen, and when the
  1247.     text will be clicked, the sound object defined as soundLinkName will be
  1248.     played. Please refer to the ~Sound~sound~ section below.
  1249.  
  1250. 15. Applications can be launced from the help database by clicking a link, that
  1251.     was defined as an application. The syntax is : ~~Text~~application-link~~
  1252.     where Text is the text that will appear to the user, and application-link
  1253.     is the identifier of the application that will be executed, as defined in
  1254.     the .APPLICATION statement. Please refer to the ~Application Launch~appLaunch~ section
  1255.     below for more information.
  1256.  
  1257. 16. User defined links (.USERLINK) can be created and used in the topic text, 
  1258.     please refer to the ~Links~links~ section below for discussion of this feature.
  1259.  
  1260. 17. The .ACTION attribute of the topic, can be used to start some action(s), 
  1261.     when the user enters the topic. This feature is supported in the WinHelp
  1262.     and MULTIMEDIA VIEWER targets. 
  1263.     e.g.  .ACTION SndPlaySound("EXPLAIN.WAV",1)
  1264.     Will use the MMSYSTEM high level sound routine (That has to be registered)
  1265.     to play a WAV file called EXPLAIN.WAV.
  1266.     Multiple .ACTION lines can be specified.
  1267.  
  1268. 18. The .TEXTATTR attribute of the topic can be used to define default 
  1269.     paragraph attributes to the topic. These attributes override the 
  1270.     .ATTRDEFAULTS statement attributes for this topic, and can be 
  1271.     over-ridden by the paragraph attributes. Please refer to the text 
  1272.     attributes section below for more information.
  1273.  
  1274. .par bold on
  1275. Additional commands include :
  1276. .endpar
  1277.  
  1278. | .TEXTCOLOR, .LINKCOLOR and .LINKHIGH - VGA colors of text and links in normal 
  1279. and high (selected) states in the native help formats.
  1280.  
  1281. The syntax of these commands is :
  1282.  
  1283. | .TEXTCOLOR w 
  1284.  
  1285. or
  1286.  
  1287. | .LINKCOLOR x
  1288.  
  1289. or
  1290.  
  1291. | .LINKHIGH y
  1292.  
  1293. Where w, x and y are the color of the text/link, which is a combination of the 
  1294. color of the foreground with the color of the background multiplied by 16.
  1295.  
  1296. The colors that can be used for both fore and background are :
  1297.  
  1298.   Black     = 0
  1299.   Blue      = 1
  1300.   Green     = 2
  1301.   Cyan      = 3
  1302.   Red       = 4
  1303.   Magenta   = 5
  1304.   Brown     = 6
  1305.   LightGray = 7
  1306.  
  1307. The colors that can be used only for the foreground are :
  1308.  
  1309.   DarkGray     = 8
  1310.   LightBlue    = 9
  1311.   LightGreen   = 10
  1312.   LightCyan    = 11
  1313.   LightRed     = 12
  1314.   LightMagenta = 13
  1315.   Yellow       = 14
  1316.   White        = 15
  1317.  
  1318. For example : to set the normal color of a link to light green on blue, use
  1319.  
  1320. | .LINKCOLOR 26
  1321.  
  1322. where 26 = 10 + 16 * 1. (10 = light green, 1 = blue).
  1323.  
  1324. .par bold on
  1325. Creating Multiple Source Projects :
  1326. .endpar
  1327.  
  1328. Use the .INCLUDE commands in the source of your .HDF file, to include an
  1329. additional source file. .INCLUDE is not supported in the middle of a topic.
  1330.  
  1331. For Example :
  1332.  
  1333.  .. some stuff 
  1334.  
  1335. | .include 2ndfile.hdf
  1336.  
  1337.  .. additional stuff
  1338.  
  1339. will process 2NDFILE.HDF in the middle of our source file.
  1340.  
  1341. Please notice - .INCLUDE commands can be nested in your source file,
  1342. it is however not recommended to nest them too deep, helpC does not
  1343. close the input file when a .INCLUDEd file is processed, in order to
  1344. minimize help generation time - there is however, a limit on the number
  1345. of open files that can be used by a program - this is a limit set by dos.
  1346.  
  1347. .par bold on
  1348. Code Insertion :
  1349. .endpar
  1350.  
  1351. Use the .INSERT CODE statement to insert target code that will not be 
  1352. translated by helpC. helpC will send un-translated code to the output target
  1353. until a .END-CODE statement is found.
  1354.  
  1355. For example - creating a small table in WinHelp format :
  1356. | .. normal code
  1357. | .ifdef windows
  1358. | .insert code
  1359. | \pard{\tab column1\tab column2\tab column3}\par
  1360. | \pard{\par col1data\tab col2data ..}\par
  1361. | .end-code
  1362. | .endif
  1363.  
  1364. .par bold on
  1365. Table Of Contents :
  1366. .endpar
  1367.  
  1368. .par
  1369. Use the .INSERT TOC command to insert the Table Of Contents of all the topics
  1370. defined in the database, sorted by alphanumeric order. Notice that databases
  1371. that use this command should be compiled using the /TN+ switch
  1372. .endpar
  1373.  
  1374. .par bold on
  1375. GUI Font based targets :
  1376. .endpar
  1377.  
  1378. The .FIXEDFONT command is used to define a non proportional font as the 
  1379. default font of the help database. Currently the only targets affected
  1380. by this command are MMViewer, WinHelp, RTF. If you find that your help 
  1381. databases are not aligned after they are converted to WinHelp format, use 
  1382. this command and re-compile. This command has no effect on targets that are 
  1383. different from the targets mentioned above.
  1384.  
  1385. The .PCFONT command is used to define a font that has the standard pc 
  1386. character set (Terminal - in windows). If you convert a text based 
  1387. database that uses the PC's special characters, use this command to
  1388. set the default font. This command has no effect on targets that are 
  1389. different from the targets mentioned above.
  1390.  
  1391. .par bold on
  1392. Text targets :
  1393. .endpar
  1394.  
  1395. The .PAGELENGTH and .PAGEWIDTH statements set the printed page length in
  1396. rows, and width in columns. The syntax is .PAGELENGTH xx or .PAGEWIDTH yy .
  1397.  
  1398. .par bold on
  1399. Font Palette :
  1400. .endpar
  1401.  
  1402. Use the .SETFONT command to change or add fonts to the font palette, The 
  1403. syntax is : .SETFONT font-number 'Font-Name-In-The-Target-Language'. If
  1404. for example we would like to change font number 3 in the windows target
  1405. to be a font X of family Y we would write : 
  1406. | .SETFONT 3 'Y X'
  1407.  
  1408. .par bold on
  1409. Text Attributes :
  1410. .endpar
  1411.  
  1412. Use the .TITLEDEFAULTS statement to set the default text attributes of the
  1413. topics titles in the help database. These defaults can be over-ridden with
  1414. the .TITLEATTR statement in the topic definition. Please refer to the Text
  1415. Attributes section below for discussion of paragraph text attributes.
  1416.  
  1417. Use the .ATTRDEFAULTS statement to set the default text attributes of 
  1418. paragraph text in the database. Please refer to the Text Attributes section 
  1419. below.
  1420.  
  1421. .par bold on
  1422. Error Handling :
  1423. .endpar
  1424.  
  1425. Use the .ERRORLEVEL command to set the error level. The syntax is .ERRORLEVEL x
  1426. where x is one of the following :
  1427.  
  1428.       0    No Check  - (Default) - No action is taken.
  1429.       1    Trap      - The link is replaced to a special topic named ERROR.
  1430.       2    Strip     - The link is replaced by the Text part only.
  1431.       3    Delete    - The text and link parts are deleted.
  1432.       9    Abort     - helpC will abort with an error message, indicating the 
  1433.                        line number.
  1434. .par
  1435. Please refer to the ~Exception Handling~exceptHandle~ section below about helpC error
  1436. processing.
  1437. .endpar
  1438.  
  1439. .par bold on
  1440. Alias Topics :
  1441. .endpar
  1442.  
  1443. .par
  1444. Use the .ALIAS command to substitute a Popup/Topic name with another name. The
  1445. syntax is .ALIAS newname origname. Whenever a newname link is found, the alias
  1446. of origname is used. This can be very useful when you want to give multiple
  1447. names to a topic, or when HLPDK source is the target of an incremental 
  1448. compiler.
  1449. .endpar
  1450.  
  1451. .par
  1452. Use the .CONTENTS command to change the initial (Overview) screen displayed by
  1453. the Help Engines. By Default this screen is called OVERVIEW.
  1454. .endpar
  1455.  
  1456. .par bold on
  1457. Graphic Support :
  1458. .endpar
  1459.  
  1460. .par
  1461. Use the .GRAPHIC statement to define a graphic object, that can be referenced
  1462. elsewhere in your document. 
  1463. The syntax is :
  1464. .endpar
  1465. | .GRAPHIC graphic-name path-to-graphic-file
  1466. Please refer to the ~Graphics~graphics~ section below, for further information.
  1467.  
  1468. .par bold on
  1469. External Links :
  1470. .endpar
  1471.  
  1472. .par
  1473. Use the .EXTLINK command to define links in external database file. With this 
  1474. command you can create multiple file target database projects. Please refer to
  1475. the ~Links~links~ section below for more information about this feature.
  1476. .endpar
  1477.  
  1478. .par bold on
  1479. Sound Support :
  1480. .endpar
  1481.  
  1482. .par
  1483. Use the .SOUND command statement to define a sound object, that can be used as
  1484. a Sound link elsewhere in your document.
  1485. The syntax is :
  1486. .endpar
  1487. | .SOUND sound-name sound-file-name
  1488. Please refer to the Sound section below for more information about this feature.
  1489.  
  1490. .par bold on
  1491. Application Launch :
  1492. .endpar
  1493.  
  1494. .par 
  1495. The .APPLICATION statement is used to define an application object that can be
  1496. launced by an application-launch-link. The syntax is :
  1497. .endpar
  1498. | .APPLICATION application-identifer application-definition
  1499. .par
  1500. where application-identifer is the identifer that will be used in 
  1501. application-launch-links, and application-definition is the path to the
  1502. application. If the application needs to get parameters, the path and the
  1503. parameters are specified in quotes. Please refer to the ~Application Launch~appLaunch~
  1504. section below for additional information.
  1505. .endpar
  1506.  
  1507. .par bold on
  1508. External Routines Support :
  1509. .endpar
  1510.  
  1511. .par
  1512. The .ROUTINE statement can be used to define external routines that can be 
  1513. called from the help database. The syntax is :
  1514. .endpar
  1515. | .ROUTINE routine-name module-name parameter-definition
  1516. .par
  1517. Where routine-name is the name of the procedure/function to be called, 
  1518. module-name is the name of the library/DLL that the routine resides in (No need
  1519. to add the .DLL extension), and parameter-definition is the definition of the
  1520. parameters that the routine receives.
  1521. The parameter definitions is a string with one character describing each
  1522. parameters type. The following definitions are used :
  1523. .endpar
  1524.  
  1525. char    C definition               Pascal definition
  1526.  
  1527. u    unsigned short (WORD)      Word
  1528. U    unsigned long  (DWORD)     Longint
  1529. i    short int                  byte
  1530. I    int                        integer
  1531. s    near char * (PSTR)         PChar
  1532. S    far char * (LPSTR)         PChar
  1533. v    void 
  1534.  
  1535. .par bold on
  1536. Embedding Files :
  1537. .endpar
  1538.  
  1539. .par
  1540. Use the .EMBEDD statement to add files to your help database. The files defined
  1541. as embedded will appear in the [baggage] section of your WinHelp/MMViewer 
  1542. project definition and will be stored with the rest of the database.
  1543. .endpar
  1544.  
  1545. The syntax is :
  1546.  
  1547. | .EMBEDD file-id path-to-file
  1548.  
  1549. .par
  1550. Where file-id is the name the file will be referenced by, and path-to-file is
  1551. the path to the file on the author's machine.
  1552. .endpar
  1553.  
  1554. .par bold on
  1555. Distributed Hypertext Databases :
  1556. .endpar
  1557.  
  1558. .par
  1559. Use the .ROOTNODE and .ROOTPATH statements to define the root node address,
  1560. and the root path address of the hypertext database, when compiling to a
  1561. distributed hypertext database format. (e.g. WWW).
  1562. .endpar
  1563.  
  1564. The syntax is :
  1565.  
  1566. | .ROOTPATH root-path-string
  1567. | .ROOTNODE root-node-address
  1568.  
  1569. .par font 13 bold on
  1570. Related Topics :
  1571. .endpar
  1572. ~Technical Documentation~TechDoc~
  1573. ~Conditional Defines~condefine~
  1574. ~Groups~GroupsDoc~
  1575. ~Text Attributes~textAttr~
  1576. ~Graphics~graphics~
  1577. ~Sound~sound~
  1578. .end-entry
  1579.  
  1580. ;******************************************************************************
  1581. ;                                    links                                    *
  1582. ;******************************************************************************
  1583. .topic links
  1584. .title Links - internal/external and special
  1585. .keywords programming links
  1586. .list hdf
  1587.  
  1588. .par
  1589. Links are the special "commands" embedded in a topic text, that provide
  1590. special functionality in the target database.
  1591. .endpar
  1592.  
  1593. .par
  1594. All links are described in the topic text as a combination of text that will
  1595. appear, and a link identifier.
  1596. .endpar
  1597.  
  1598. The syntax, in a topic text for a link is :
  1599.  
  1600.  .. Some Standard Text .. ~~Link Text~~Link Id~~ .. some more text ..
  1601.  
  1602. Link Id is a unique identifier that describe this link.
  1603.  
  1604. .par
  1605. The most common link, is a topic link, this link allows the user to click on
  1606. the Link Text, that is usually in a different color than the rest of the text,
  1607. and by clicking on this texs, the topic in the help engine window is replaced,
  1608. with the topic that has the same identifier as the Link Id specified in the
  1609. identifier.
  1610. (A Topic is defined by a .topic statement somewhere else in the source file).
  1611. .endpar
  1612.  
  1613. .par
  1614. Another type of link, is the Popup link. When the Link Id is the Id of a popup,
  1615. clicking on the link will display the popup text in a window, and retain the 
  1616. original topic in the help engine window. 
  1617. (A Popup is defined by a .popup statement somewhere else in the source file).
  1618. .endpar
  1619.  
  1620. .par
  1621. Links can be used, to embedd non-textual information in the topic text. A 
  1622. common non-textual is a graphic link, when the Link Id is the Id of a graphic
  1623. object (defined by a .graphic statement somewhere else in our source), the
  1624. place of the link will be replaced by a graphic picture, in targets that 
  1625. support graphics (such as WinHelp and OS/2 IPF), and remain the Link Text
  1626. in targets that do not supprot graphics.
  1627. .endpar
  1628.  
  1629. .par
  1630. Another non-textual link is a sound link. A sound link plays a sound file 
  1631. when a sound object (defined with the .SOUND statement) is clicked by the
  1632. user. 
  1633. .endpar
  1634.  
  1635. .par
  1636. Applications can be lauched from a link, when the link key is the identifer of
  1637. an application defined with the .APPLICATION statement.
  1638. .endpar
  1639.  
  1640. .par
  1641. Other links can be created using "User Defined Link Templates", with this 
  1642. feature a link template can be created to support additional code translations.
  1643. Please refer to the ~Extending HDF~extendingHDF~ section below for additional information
  1644. on User defined links.
  1645. .endpar
  1646.  
  1647. .par
  1648. When helpC recognizes a link, the following sequence of
  1649. link recognition occurs -
  1650. .endpar
  1651. 1. Try to match link with a graphic object.
  1652. 2. If failed - try to match link with a sound object.
  1653. 3. If failed - try to match link with an application object.
  1654. 4. If failed - try to match link with a user defined link.
  1655. 5. If failed - try to match link with a popup.
  1656. 6. If failed - try to match link with a topic.
  1657. 7. If failed - try to match link with an external topic. (.EXTLINK)
  1658. 8. If failed - opearate according to the current error-level.
  1659.  
  1660. .par font 13 bold on
  1661. Related Topics :
  1662. .endpar
  1663. ~Application Launch~appLaunch~
  1664. ~Graphics~graphics~
  1665. ~Sound~Sound~
  1666. ~Exception Handling~exceptHandle~
  1667. ~Technical Documentation~TechDoc~
  1668. ~.HDF Syntax~hdf~
  1669. ~Help Compiler~helpc~
  1670. .end-topic
  1671.  
  1672. ;******************************************************************************
  1673. ;                                  conDefine                                  *
  1674. ;******************************************************************************
  1675. .topic conDefine
  1676. .title Conditional Defines
  1677. .keywords programming conditional
  1678. .list hdf
  1679.  
  1680. .par
  1681. The helpC compiler supports conditional define directives that allow you to
  1682. tailor your source according to define symbols that are known to the compiler.
  1683. .endpar
  1684.  
  1685. .par
  1686. You can use the .ifdef, .ifndef, .else and .endif directives to test the
  1687. target of your compile and do different things according to this target.
  1688. .endpar
  1689.  
  1690. .par
  1691. If for example you have a Windows bitmap you want to include in your generated
  1692. RTF file, when you compile to WinHelp format, but, you would like to use a
  1693. statement in other targets that do not support graphics, you could do the 
  1694. following :
  1695. .endpar
  1696.  
  1697. | .ifdef windows
  1698. |   some text {\bmc mybmp.bmp\} some more text
  1699. | .else 
  1700. |   some text AND STATEMENT HERE some more text
  1701. | .endif
  1702.  
  1703. .par
  1704. When the compiler will generate the code, the RTF command \bmc will be 
  1705. inserted in the output of the compiler for windows targets (/W30, /W31), 
  1706. and a simple text statement will be inserted otherwise.
  1707. .endpar
  1708.  
  1709. The conditional directives supported are :
  1710.  
  1711. | .ifdef  SYMBOL - Compile code only if SYMBOL is defined.
  1712. | .ifndef SYMBOL - Compile code only if SYMBOL is NOT defined.
  1713. | .endif         - Any .ifdef/.ifndef should be terminated by a .endif .
  1714. | .else          - Reverse the previous .ifdef/.ifndef
  1715.  
  1716. The following SYMBOLS are automatically defined by the compiler :
  1717.  
  1718. Symbol          When Defined
  1719. ------          ------------
  1720. DEF             /PX+
  1721. W31             /W31
  1722. W30             /W30
  1723. THS             /TH+
  1724. QHS             /QH+
  1725. TVH             /TV+
  1726. PHS             /PH+
  1727. DVX             /XD+
  1728. MEM             /MT+
  1729. OS2             /OS2
  1730. TXT             /TXT
  1731. WINDOWS         /W30, /W31
  1732. THELP           /TH+
  1733. QUICKHELP       /QH+
  1734. TVHC            /TV+
  1735. NATIVEPARADOX   /PX+
  1736. POPHELP         /PH+
  1737. DESQVIEW/X      /XD+
  1738. NATIVEMEMORY    /MT+
  1739. VERx.y          When Compiling with helpC Vx.y 
  1740. NATIVE          /PX+, /MT+
  1741. DOCUMENT        /TXT, /RTF
  1742. RTFBASED        /W+, /RTF, /W30, /W31, /MMV
  1743. PRP             /PP+
  1744. PREPROCESS      /PP+
  1745. MMV             /MMV
  1746. MMVIEWER        /MMV
  1747. VIEWER          /MMV
  1748. WWW             /WWW
  1749. HTML            /WWW
  1750.  
  1751. .par
  1752. You can define your own conditional defines on the command line using the /D:
  1753. switch of helpC.
  1754. .endpar
  1755.  
  1756. e.g.
  1757.  
  1758. Source :
  1759.  
  1760. | ... some text ..
  1761. | .ifdef mydef
  1762. |   Special Text for mydef situation
  1763. | .endif
  1764. | ... more text
  1765.  
  1766. and you compile using HELPC /D:MYDEF the special text will be included.
  1767.  
  1768. .par font 13 bold on
  1769. Related Topics :
  1770. .endpar
  1771. ~Technical Documentation~techDoc~
  1772. ~Help Definition~hdf~
  1773.  
  1774. .end-topic
  1775.  
  1776. ;******************************************************************************
  1777. ;                                  textAttr                                   *
  1778. ;******************************************************************************
  1779. .topic textAttr
  1780. .title Text Attributes
  1781. .keywords programming attributes text
  1782. .list hdf
  1783.  
  1784. .par 
  1785. Topic's text can receive visual attributes such as a font, size, bold, 
  1786. italic etc.. by using the paragraph attributes on the .PARAGRAPH (.par)
  1787. line. Text attributes are currently supported in the MMViewer, WinHelp and RTF 
  1788. targets. Some attributes are also supported in HTML (WWW) and IPF targets.
  1789. .endpar
  1790.  
  1791. The attributes that can be applied to text are :
  1792.  
  1793. Font            - The font the text will be displayed in.
  1794. Bold            - The text is displayed in bold characters.
  1795. Italic          - The text is displayed in italic characters.
  1796. Underline       - The text is displayed in underline characters.
  1797. Size            - The size of the font.
  1798. Box             - The paragraph can be contained in a box.
  1799. Align           - The paragraph can be alligned.
  1800. Color           - The text foreground color.
  1801. BgColor         - The text background color.
  1802. Scroll          - Set scroll/No Scroll.
  1803.  
  1804. The syntax is :
  1805.  
  1806. | .PARAGRAPH [attr1 attr1-parameters [attr2 attr2-parameters [..] ]]
  1807.  
  1808. The allowed parameters to attributes are :
  1809.  
  1810. 1. FONT font-number-in-font-palette : The font number in the font palette, there
  1811. is a standard font palette for MMViewer, WinHelp and rtf targets that include 
  1812. the following fonts :
  1813.  
  1814.  0 : Times Roman        (roman Tms Rmn)
  1815.  1 : Symbol             (decor Symbol)
  1816.  2 : Helvetica          (swiss Helv)
  1817.  3 : LinePrinter        (modern LinePrinter)
  1818.  4 : Terminal           (roman Terminal)
  1819.  5 : Times New Roman    (roman Times New Roman)
  1820.  6 : Arial              (swiss Arial)
  1821.  7 : CG Times (WN)      (roman CG Times (WN))
  1822.  8 : Courier            (modern Courier)
  1823.  9 : Modern             (modern Modern)
  1824. 10 : Script             (script Script)
  1825. 11 : Univers (WN)       (swiss Univers (WN))
  1826. 12 : Wingdings          (nil Wingdings)
  1827. 13 : MS Sans Serif      (swiss MS Sans Serif)
  1828.  
  1829. 2. BOLD ON|OFF - Set bold mode to on/off.
  1830.  
  1831. 3. ITALIC ON|OFF - Set italic mode to on/off.
  1832.  
  1833. 4. UNDERLINE ON|OFF - Set underline mode on/off.
  1834.  
  1835. 5. SIZE font-size - Set the size of the font.
  1836.  
  1837. 6. BOX NONE|NORMAL|THICK|SHADOW|DOUBLE - Print paragraph in a box which has one
  1838. of the described borders : NONE is no border at all.
  1839.  
  1840. 7. ALIGN LEFT|RIGHT|CENTER|JUSTIFY - Print the text in the paragraph aligned
  1841. to one of the sides, the center or justified in the paragraph.
  1842.  
  1843. 8. COLOR color-number-in-color-palette - The numbers are the same numbers used
  1844. for dos native systems and described in the help definition format section
  1845. above, regarding the .LINKCOLOR, .TEXTCOLOR and .LINKHIGH statements.
  1846.  
  1847. 9. BGCOLOR color-in-palette - Same as the COLOR parameter, but used for the 
  1848. background color. Currently supported only in the WinHelp .TITLEDEFAULTS
  1849. and .ATTRDEFAULTS statements.
  1850.  
  1851. 10. SCROLL ON|OFF - useful only in WinHelp/Multimedia Viewer title attributes,
  1852. if you set SCROLL OFF a non scrolling region is created.
  1853.  
  1854. Example :
  1855.  
  1856. | .PAR BOX SHADOW FONT 13 BOLD ON
  1857. |    ... some text here ..
  1858. | .ENDPAR
  1859.  
  1860. Will display the paragraph in a shadow bordered box, using font 13 in the 
  1861. palette (MS Sans Serif assuming that the original palette is used) with bold
  1862. characters.
  1863.  
  1864. .par font 13 bold on
  1865. Related Topics :
  1866. .endpar
  1867. ~Technical Documentation~techDoc~
  1868. ~Help Definition~hdf~
  1869.  
  1870. .end-topic
  1871.  
  1872. ;******************************************************************************
  1873. ;                                  groupsDoc                                  *
  1874. ;******************************************************************************
  1875. .topic groupsDoc
  1876. .title Groups Definition and Usage
  1877. .keywords programming groups
  1878. .list hdf
  1879.  
  1880. Topics can be associated to groups using the .GROUPS statement in the topic
  1881. heading. Menus to these groups can later be created by using the 
  1882. command .INSERT GROUP group-name in the topic text.
  1883.  
  1884. An example will clarify the use of this function :
  1885.  
  1886. Let us assume that we have a car's collectors database, where the description
  1887. of each car is a topic. We would like to present a hierarchy to the user that
  1888. looks like that : 
  1889.  
  1890. Overview Screen
  1891.    |
  1892.    +--------- Cars by Country
  1893.    |               |
  1894.    |               +------------ U.S.A ... List of cars manufactured in U.S.A
  1895.    |               +------------ U.K.
  1896.    |               +------------ Italy
  1897.    |
  1898.    +--------- Cars by Maker
  1899.    |               |
  1900.    |               +------------ Alfa-Romeo ... List of Alfa-Romeo models
  1901.    |               +------------ GM
  1902.    |               +------------ Mazda
  1903.    |
  1904.    +--------- Cars by type
  1905.                    |
  1906.                    +------------ 4x4 & Jeeps
  1907.                    +------------ Sport Cars
  1908.                    +------------ Family Sedans
  1909.                         
  1910. We will create group references in the topics using the .GROUPS statement,
  1911. The Alfa Romeo Spider 2000 topic will look like :
  1912.  
  1913. | .topic alfa_romeo_spider_2000
  1914. | .title Alfa Romeo Spider 2000
  1915. | .keywords alfa spider convertible sport classic
  1916. | .groups italian alfa sport
  1917. | 
  1918. | The Alfa Romeo ... 
  1919. | 
  1920. | 
  1921. | .end-topic
  1922.  
  1923. The Italian Cars Directory topic will be :
  1924.  
  1925. | .topic italy_directory
  1926. | .title Italian Cars Directory
  1927. | .keywords directory
  1928. | 
  1929. | Cars Manufactured in Italy :
  1930. | 
  1931. | .insert group italian
  1932. | 
  1933. | .end-topic
  1934.  
  1935. If our database includes 3 cars that have a reference to the Italian group
  1936. this will be the equivalent of writing :
  1937.  
  1938. | .topic italy_directory
  1939. | .title Italian Cars Directory
  1940. | .keywords directory
  1941. | 
  1942. | Cars Manufactured in Italy :
  1943. | 
  1944. | ~~Alfa Romeo Spider 2000~~alfa_romeo_spider_2000~~
  1945. | ~~Ferrari 308 GTS~~Ferrari_308_gts~~
  1946. | ~~Fiat Uno 70S~~fiat_uno_70s~~
  1947. | 
  1948. | .end-topic
  1949.  
  1950. .par font 13 bold on
  1951. Related Topics :
  1952. .endpar
  1953. ~Technical Documentation~TechDoc~
  1954. ~.HDF Syntax~hdf~
  1955. ~Conditional Defines~condefine~
  1956. .end-topic
  1957.  
  1958. ;******************************************************************************
  1959. ;                                exceptHandle                                 *
  1960. ;******************************************************************************
  1961. .topic exceptHandle
  1962. .title Exception Handling
  1963. .keywords programming exception
  1964. .list hdf
  1965.  
  1966. .par
  1967. helpC provides mechanism to handle link exceptions. An exception is a link
  1968. to an identifier that is not defined as a Topic or PopUp. In order to help
  1969. you find these errors helpC contains the cross reference report that can
  1970. be produced using the /R+ switch. You can browse the HELPC.LST file generated
  1971. by helpC if a cross reference report is generated, and search for the string
  1972. ERROR that describes undefined links.
  1973. .endpar
  1974.  
  1975. .par
  1976. helpC provides additional exception handling facilities. When an error is found
  1977. during compile helpC can perform on of the following actions :
  1978. .endpar
  1979.  
  1980. 0: No Check - Default - helpC does not do anything. The link is passed as is to
  1981.               the target. The target help engine/compiler will handle the 
  1982.               exception as it is implemented.
  1983.  
  1984. 1: Trap     - helpC will replace the link key with the key ERROR. It is the 
  1985.               responsibility of the help database author to provide such a
  1986.               topic/popup.
  1987.  
  1988. 2: Strip    - helpC will pass the text of the link to the target with no link
  1989.               support. The text will appear as normal text.
  1990.  
  1991. 3: Delete   - Both the text and the link will be deleted and will not appear in
  1992.               the target.
  1993.  
  1994. 9: Abort    - helpC will abort, with an error message, indicating the line the 
  1995.               link is defined. This mode is recommended when you are debugging 
  1996.               your help database.
  1997.  
  1998. You can set the error level using the following techniques :
  1999.  
  2000. - Use the /EL=x switch on the helpC command line.
  2001.  
  2002. - Use the .ERRORLEVEL x .HDF statement.
  2003.  
  2004. .par bold on
  2005. Important Points :
  2006. .endpar
  2007.  
  2008. .par
  2009. 1. When errorLevel = 0 (default) no topic database is created during pass 1,
  2010. if you set .errorlevel somewhere in your source, after some topics/popups
  2011. have been defined, these topics will not be in the symbol table created by
  2012. helpC and will be considered an exception!.
  2013. .endpar
  2014.  
  2015. .par
  2016. 2. You can use the /FC+ switch to "Force Collection" of Topics data, even when
  2017. the ERRORLEVEL is 0.
  2018. .endpar
  2019.  
  2020. .par font 13 bold on
  2021. Related Topics :
  2022. .endpar
  2023. ~Technical Documentation~TechDoc~
  2024. ~.HDF Syntax~hdf~
  2025. ~Help Compiler~helpc~
  2026.  
  2027. .end-topic
  2028.  
  2029. ;******************************************************************************
  2030. ;                                  graphics                                   *
  2031. ;******************************************************************************
  2032. .topic graphics
  2033. .title Native Graphics Support
  2034. .keywords programming graphics
  2035. .list hdf
  2036.  
  2037. .par
  2038. Native Graphic support is provided by graphic "links", and graphic object
  2039. definitions.
  2040. .endpar
  2041.  
  2042. .par
  2043. In order to incorporate graphics into your database, use the .GRAPHIC
  2044. command to define a graphic object. This command associates a graphic file
  2045. with a unique identifier.
  2046. .endpar
  2047.  
  2048. .par
  2049. Whenever you want to use the graphic image in one of your topics, you should
  2050. define a link with the following syntax :
  2051. .endpar
  2052.  
  2053. ~~Link Text in non-graphic targets~~graphic-identifier~~
  2054.  
  2055. .par
  2056. If the target of the compiler has no helpC native graphic support, the 
  2057. "Link Text in non-graphic targets" sentance will be used, if the target 
  2058. is supported, the graphic-identifier will be displayed.
  2059. .endpar
  2060.  
  2061. .par
  2062. In this version of HLPDK native graphics support is provided for WinHelp,
  2063. Microsoft Multimedia Viewer (MMViewer), WWW and OS/2 IPF Bitmaps.
  2064. .endpar
  2065.  
  2066. .par
  2067. Notice that the graphic-identifier must be unique, and must not be identical
  2068. to a topic/popup/sound name. Please refer to the ~Links~links~ section for
  2069. link recognition sequence information.
  2070. .endpar
  2071.  
  2072. .par
  2073. Link Modifiers are attributes that are defined after the link name, separated
  2074. with the ";" character.
  2075. .endpar
  2076.  
  2077. The following modifiers are defined for Graphic support :
  2078.  
  2079. Left   : Align the graphic object to the left of the window.
  2080. Right  : Align the graphic object to the right of the window.
  2081. Center : Align the graphic object to the center of the window.
  2082.  
  2083. .par
  2084. Please refer to one of the standard documentation examples that are supplied
  2085. with the HLPDK package, for demos of graphic use.
  2086. .endpar
  2087.  
  2088. .par font 13 bold on
  2089. Related Topics :
  2090. .endpar
  2091. ~Technical Documentation~TechDoc~
  2092. ~.HDF Syntax~hdf~
  2093. ~Help Compiler~helpc~
  2094. ~Links~links~
  2095. .end-topic
  2096.  
  2097. ;******************************************************************************
  2098. ;                                    sound                                    *
  2099. ;******************************************************************************
  2100. .topic sound
  2101. .title Native Sound Support
  2102. .keywords programming sound
  2103. .list hdf
  2104.  
  2105. Sound support is provided by sound "links", and sound object definition.
  2106.  
  2107. .par
  2108. In order to incorporate sound into your database, use the .SOUND command
  2109. to define a sound object. This command associates a sound file (WAV in windows)
  2110. with a unique identifier.
  2111. .endpar
  2112.  
  2113. .par
  2114. Whenever you want to use the sound object in one of your topics, you have to
  2115. define a link with the following syntax :
  2116. .endpar
  2117.  
  2118. ~~Text To Be Clicked On~~sound-identifier~~
  2119.  
  2120. .par
  2121. Currently, Sound support is available only in the MMViewer and WinHelp targets.
  2122. The name of the sound object in this version should be a WAV file, that 
  2123. is in the \WINDOWS directory. The WINDOWS MMSYSTEM multi-media support looks
  2124. for the sound file in this directory!.
  2125. .endpar
  2126.  
  2127. .par font 13 bold on
  2128. Related Topics :
  2129. .endpar
  2130. ~Technical Documentation~TechDoc~
  2131. ~.HDF Syntax~hdf~
  2132. ~Help Compiler~helpc~
  2133. ~Links~links~
  2134. .end-topic
  2135.  
  2136. ;******************************************************************************
  2137. ;                                  appLaunch                                  *
  2138. ;******************************************************************************
  2139. .topic appLaunch
  2140. .title Application Launch
  2141. .keywords programming application launch
  2142. .list hdf
  2143.  
  2144. .par
  2145. Applications can be launched from the help database using application launch 
  2146. links, and application definitions.
  2147. .endpar
  2148.  
  2149. .par
  2150. An application has to be defined using the .APPLICATION statement that uses the
  2151. following syntax :
  2152. .endpar
  2153.  
  2154. | .APPLICATION application-id 'application-activation-code'
  2155.  
  2156. .par
  2157. Where application-id is the identifier to the application that will be used 
  2158. in application launch links, and the application-activation-code is the 
  2159. [optional] path to the application and the application executable. If 
  2160. parameters should be specified, the application-activation-code should be
  2161. surrounded by quotes, with a space separating the path to the application from
  2162. the parameters.
  2163. .endpar
  2164.  
  2165. .par
  2166. When you want to include an application launch in the topic text, the 
  2167. application-id should be used as the key of a link.
  2168. .endpar
  2169. e.g. ~~Press Here To Run XXX.EXE~~application-id~~
  2170.  
  2171.  
  2172. .par font 13 bold on
  2173. Related Topics :
  2174. .endpar
  2175. ~Technical Documentation~TechDoc~
  2176. ~.HDF Syntax~hdf~
  2177. ~Help Compiler~helpc~
  2178. ~Links~links~
  2179. .end-topic
  2180.  
  2181. ;******************************************************************************
  2182. ;                                 complexProj                                 *
  2183. ;******************************************************************************
  2184. .topic complexProj
  2185. .title Complex Projects (Multiple file target databases)
  2186. .keywords programming
  2187. .list hdf
  2188.  
  2189. .par
  2190. helpC supports multiple file target databases, with the use of the following
  2191. HDF statements : .EXTLINK, and .EXPORT .
  2192. .endpar
  2193.  
  2194. .par
  2195. When a link that exists in an external database is needed, the .EXTLINK 
  2196. statement is used to define the properties and attributes of that link.
  2197. .endpar
  2198.  
  2199. .par
  2200. The most important property - is the database name, that defines which 
  2201. database should be called. Other attributes include the title, keywords,
  2202. numeric references and groups this external topic should be associated with.
  2203. .endpar
  2204.  
  2205. .par
  2206. If we have a "simple" complex project, with only 2 databases, and links 
  2207. between them, we might not find it difficult to define the "public" links
  2208. of database 1 in database 2, and vice versa, but - if the project involves
  2209. more databases, we might find it hard to create these public references to
  2210. all external database, in each database. We can, however, define .EXTLINK
  2211. statements of the public links of each database, in a separate file, and
  2212. use the .INCLUDE statement to include them, in the other statements.
  2213. .endpar
  2214.  
  2215. .par
  2216. helpC can be used, with the /PP+ switch, to create these "reference" export
  2217. files, with the name of database.EXP when we use the following command :
  2218. .endpar
  2219.  
  2220. HELPC /PP+ database-name
  2221.  
  2222. .par
  2223. If we want a .EXTLINK statement to be created for a topic, we have to
  2224. add the .EXPORT attribute to the topic defintion. An alternative is to use
  2225. the /EA+ switch of the helpC compiler, that exports all topics in the database,
  2226. in a PreProcess target compile (/PP+).
  2227. .endpar
  2228.  
  2229. The .EXTLINK statement has the following syntax :
  2230.  
  2231. | .EXTLINK database 'topic-identifier'
  2232. | [.TITLE topic-title]
  2233. | [.REFERENCE topic-numeric-reference]
  2234. | [.KEYWORDS keyword [keyword ..] ]
  2235. | [.GROUPS group [group ..] ]
  2236. | .END-EXTLINK
  2237.  
  2238. .par
  2239. Where database is the name of the external database that the link is in,
  2240. topic-identifier is the id of the link in the external database, title, 
  2241. keywords and groups have the same meaning as in the .TOPIC definition, and
  2242. the topc-numeric-reference is a numeric reference associated with the 
  2243. topic, in the external database, if this is needed.
  2244. .endpar
  2245.  
  2246. .par font 13 bold on
  2247. Related Topics :
  2248. .endpar
  2249. ~Technical Documentation~TechDoc~
  2250. ~.HDF Syntax~hdf~
  2251. ~Help Compiler~helpc~
  2252. .end-topic
  2253.  
  2254. ;******************************************************************************
  2255. ;                                  extendHDF                                  *
  2256. ;******************************************************************************
  2257. .topic extendingHDF
  2258. .title Extending HDF
  2259. .keywords programming userlink
  2260. .list hdf
  2261.  
  2262. .par
  2263. The HDF syntax can be extended by creating "User Defined Link Templates", 
  2264. with these templates special links can be created, that can be used to support
  2265. additional link types.
  2266. .endpar
  2267.  
  2268. In order to create a user link template, use the following statement :
  2269.  
  2270. | .USERLINK userlink-id template
  2271.  
  2272. .par
  2273. Where userlink-id is the name of the template, and template defines the way
  2274. the link will be translated.
  2275. .endpar
  2276.  
  2277. The template can include the following substitution characters :
  2278.  
  2279. %%              - Replace with a %
  2280. %t              - Replace with the text of the link
  2281. %k              - Replace with the key of the link
  2282. %1, %2, .. %9   - Replace with parameter #x
  2283. %o              - Replace with target (output) database name.
  2284. %c              - Replace with context-id (topic name) of current topic.
  2285. %n              - Replace with a carrige-return and newline characters.
  2286. %r1, %r2, ..    - Replace with the resolution number of the topic-id in 
  2287.                   parameter x. This is needed for links in IPF (OS/2) and
  2288.                   PopHelp targets.
  2289. %g1, %g2, ..    - Replace with the graphic object whose id is in parameter x.
  2290. %s1, %s2, ..    - Replace with the sound object whose id is in parameter x.
  2291. %a1, %a2, ..    - Replace with the application object, whose id is in parm x.
  2292. %e1, %e2, ..    - Replace with the embedded object, whose name is in parm x. 
  2293.                   Notice, that only the file name and extension are returned,
  2294.                   while in the %gx, %sx and %ax, the entire path is returned.
  2295.  
  2296. User links can be used in the topic text with the following syntax :
  2297.  
  2298.    .. some text ~~link-text~~userlink-id(param1 param2 ..)~~ .. more text
  2299.  
  2300. .par
  2301. Use this command to extend the HDF syntax. You can even create special 
  2302. libraries to support video/animation etc.. from the help databases, with these
  2303. extensions.
  2304. .endpar
  2305.  
  2306. .par
  2307. e.g. - To create a link to a topic, with a graphic bitmap, we could define
  2308. the following User Link : (Example for WinHelp/MMViewer)
  2309. .endpar
  2310.  
  2311. .ifndef rtfbased
  2312. | .userlink graphicJump '{\uldb \{bmc %g1\} %t}{\v %2}'
  2313. .else 
  2314. | .userlink graphicJump '{\uldb \{bmX %g1\} %t}{\v %2}'
  2315.  
  2316. Where X in  \{bmX is r, l or c
  2317. .endif
  2318.  
  2319. And assuming we defined a graphic object as 
  2320.  
  2321. | .graphic mypicture ronp.bmp
  2322.  
  2323. We could create a graphic links such as :
  2324.  
  2325.   Click ~~Ron Loewy~~graphicJump(mypicture ronTopic)~~ to know about the author.
  2326.  
  2327. In the target RTF this will be translated to :
  2328.  
  2329. .ifdef rtfBased
  2330.   Click {\uldb \{bmX ronp.bmp\} Ron Loewy}{\v ronTopic} to know about the author.
  2331. .else
  2332.   Click {\uldb \{bmc ronp.bmp\} Ron Loewy}{\v ronTopic} to know about the author.
  2333. .endif
  2334.  
  2335. .par
  2336. HLPDK includes a standard system extension library, that uses userlink 
  2337. templates to support in-paragraph text attributes, extended grtaphic, video,
  2338. CDAudio, animation and other multimedia items. Please refer to the HDKLIB.DOC
  2339. file for additional information.
  2340. .endpar
  2341.  
  2342. .par font 13 bold on
  2343. Related Topics :
  2344. .endpar
  2345. ~Technical Documentation~TechDoc~
  2346. ~Links~links~
  2347. ~.HDF Syntax~hdf~
  2348. ~Help Compiler~helpc~
  2349. .end-topic
  2350.  
  2351. ;******************************************************************************
  2352. ;                                     tif                                     *
  2353. ;******************************************************************************
  2354. .entry tif
  2355. .title Topic Index Format
  2356. .keywords programming
  2357.  
  2358.   The topic index table format is as follows :
  2359.  
  2360.   TOPIC     - 40 characters string key - this is the topic "name".
  2361.   FILENAME  - 38 characters string field - includes the name of the
  2362.               help raw data file. (Notice - V1.0 ignores the value of this 
  2363.               field, it is here for future expansion).
  2364.   START     - longint (long) field that contains the offset from the data file
  2365.               start, to the start of the topics text data, in bytes.
  2366.   LEN       - longint (long) field that contains the length (in bytes) of the 
  2367.               text data of the topic.
  2368.   TITLE     - 70 characters string key - the title of the topic.
  2369.   TTYPE     - 1 character - topic type. Currently supported types are :
  2370.               'T' = Topic.
  2371.               'P' = Popup.
  2372.  
  2373. .par font 13 bold on
  2374. Related Topics :
  2375. .endpar
  2376. ~Technical Documentation~TechDoc~
  2377. ~Links Index Format~lif~
  2378. ~Keywords Index Format~kif~
  2379. ~Set File Format~sff~
  2380. .end-entry
  2381.  
  2382. ;******************************************************************************
  2383. ;                                     lif                                     *
  2384. ;******************************************************************************
  2385. .entry lif
  2386. .title Links Index Format
  2387. .keywords programming
  2388.  
  2389.   The links index table format is as follows :
  2390.  
  2391.   TOPIC     - 40 characters string key - the name of the topic that 
  2392.               has the link.
  2393.   SEQ       - integer (int) key - contains the sequential number of 
  2394.               the link in the topic. (This way you can assign the links
  2395.               order in the topic).
  2396.   LINK      - 40 characters string key - the name of the link topic to
  2397.               display if the link is chosen.
  2398.   LINE      - integer (int) field - the line (from the start of the topic) 
  2399.               this link is displayed on.
  2400.   COL       - integer (int) field - the column this link is displayed on.
  2401.   TXT       - 70 characters string field - the text to display on the line.
  2402.  
  2403. .par font 13 bold on
  2404. Related Topics :
  2405. .endpar
  2406. ~Technical Documentation~TechDoc~
  2407. ~Topic Index Format~tif~
  2408. ~Keywords Index Format~kif~
  2409. ~Set File Format~sff~
  2410. .end-entry
  2411.  
  2412. ;******************************************************************************
  2413. ;                                     sff                                     *
  2414. ;******************************************************************************
  2415. .entry sff
  2416. .title Set File Format
  2417. .keywords programming
  2418.  
  2419. .par
  2420. The set file is a text file that contains one entry in each line, using
  2421. the following format :
  2422. .endpar
  2423.  
  2424. help-database-engine
  2425. version-of-generating-compiler
  2426. topic-index-table name
  2427. links-index-table name
  2428. keywords-index-table name
  2429. help-raw-data-file name
  2430. number-of-topics
  2431. length-of-file
  2432. link-normal-color
  2433. link-high-color
  2434. text-normal-color
  2435. contents-topic-name
  2436.  
  2437. .par
  2438. The help-database-engine values available today are DEF=Paradox and 
  2439. MEM=memory Tables.
  2440. .endpar
  2441.  
  2442. .par font 13 bold on
  2443. Related Topics:
  2444. .endpar
  2445. ~Technical Documentation~TechDoc~
  2446. ~Topic Index Format~tif~
  2447. ~Links Index Format~lif~
  2448. ~Keywords Index Format~kif~
  2449. .end-entry
  2450.  
  2451. ;******************************************************************************
  2452. ;                                     kif                                     *
  2453. ;******************************************************************************
  2454. .topic kif
  2455. .title Keywords Index Format
  2456. .keywords programming
  2457.  
  2458.   The keywords index table format is as follows :
  2459.  
  2460.   KEYWORD   - 40 characters string key - the keyword.
  2461.   TOPIC     - 40 characters string key - the topic name that this keyword is 
  2462.               assigned to.
  2463.  
  2464.   Notice - the database will include a row for each keyword, that has the 
  2465.   TOPIC field blank. This is used to display the first list of keywords, that
  2466.   if chosen, will display the 2nd list of topics that have the chosen keyword
  2467.   in their .KEYWORDS definition.
  2468.  
  2469. .par font 13 bold on
  2470. Related Topics:
  2471. .endpar
  2472. ~Technical Documentation~TechDoc~
  2473. ~Topic Index Format~tif~
  2474. ~Links Index Format~lif~
  2475. ~Set File Format~sff~
  2476. .end-topic
  2477.  
  2478. ;******************************************************************************
  2479. ;                                otherProducts                                *
  2480. ;******************************************************************************
  2481. .topic otherProducts
  2482. .title Related Products
  2483. .keywords contact
  2484.  
  2485. The following products/packages provide additional HLPDK functionality :
  2486.  
  2487. 1. Name         : IL2HDK - Interrupt List (Ralf Brown) 2 HLPDK convert program. 
  2488.    Version      : 3.1
  2489.    Availability : IL2HDK31.ZIP. (OS/2)
  2490.    Status       : Free. 
  2491.    Author       : Ron Loewy.
  2492.  
  2493. 2. Name         : HPCHDK - HelpPC 2 HLPDK convert program.
  2494.    Version      : 1.0
  2495.    Availability : HPCHDK10.ZIP.
  2496.    Status       : Free.
  2497.    Author       : Yaniv Golan (s2942275@tech02.technion.ac.il)
  2498.  
  2499. 3. Name         : SCANHELP - Turbo Pascal Scanner to help.
  2500.    Version      : 3.26
  2501.    Availability : SCANH326.ZIP (Contact Author)
  2502.    Status       : Shareware.
  2503.    Author       : Duncan J. Murdoch (dmurdoch@mast.QueensU.CA)
  2504.  
  2505. 4. Name         : NG2HDK - Norton Guides 2 HLPDK convert program.
  2506.    Version      : 1.0
  2507.    Availability : NG2HDK10.ZIP
  2508.    Status       : Free.
  2509.    Author       : Ron Loewy.
  2510.  
  2511. 5. Name         : NEWSDB - usenet News Clips Hypertext generator.
  2512.    Version      : 1.0.
  2513.    Availability : NEWSDB10.ZIP
  2514.    Status       : Shareware.
  2515.    Author       : Ron Loewy.
  2516.  
  2517. 6. Name         : POPHDK - POPHELP 2 HLPDK convert program.
  2518.    Version      : 1.0
  2519.    Availability : POPHDK10.ZIP.
  2520.    Status       : Free.
  2521.    Author       : Yaniv Golan (s2942275@tech02.technion.ac.il)
  2522.  
  2523. 7. Name         : JARG2HDK - Jargon File to HLPDK convert program.
  2524.    Version      : 1.0
  2525.    Availability : ? (Contact Author)
  2526.    Status       : ?
  2527.    Author       : Slren Pingel Dalsgaard (pingel@daimi.aau.dk)
  2528.  
  2529. 8. Name         : RC2HDK - Windows Resource File Help Template Generator.
  2530.    Version      : 2.0
  2531.    Availability : RC2HDK20.ZIP.
  2532.    Status       : Shareware.
  2533.    Author       : Ron Loewy.
  2534.  
  2535. 9. Name         : CPFHDK - C++ FAQ 2 HLPDK convert program.
  2536.    Version      : 1.0
  2537.    Availability : Contact author.
  2538.    Status       : Free ?
  2539.    Author       : Yaniv Golan (s2942275@tech02.technion.ac.il)
  2540.  
  2541. 10.Name         : CVTOPHLP - OPRO Help 2 HLPDK convert program.
  2542.    Version      : ?
  2543.    Availability : CIS:PCVENB forum, Sect. TurboPower, CVTHLP.LZH
  2544.    Status       : Free to OPro/TPro owners ?
  2545.    Author       : Julian M. Bucknall, TurboPower Software, CIS:100116,1572
  2546.  
  2547. 11.Name         : TPF2HDK - Timo Salmi's Pascal FAQ 2 HLPDK convert program.
  2548.    Version      : 1.0
  2549.    Availability : TPFHDK10.ZIP
  2550.    Status       : Free.
  2551.    Author       : Ron Loewy.
  2552.  
  2553. Currently under development : RTF2HDK, HDKEDIT and more ..
  2554.  
  2555. .end-topic
  2556.  
  2557. .ifndef txt
  2558.  
  2559. ;******************************************************************************
  2560. ;                                     toc                                     *
  2561. ;******************************************************************************
  2562. .topic toc
  2563. .title Table Of Contents
  2564.  
  2565. .insert toc
  2566.  
  2567. .end-topic
  2568.  
  2569. .endif
  2570.  
  2571.  
  2572.  
  2573.  
  2574.